<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>JavaNameGenerator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/torque/engine/database/model/JavaNameGenerator.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../../../org/apache/torque/engine/database/model/package-summary.html">org.apache.torque.engine.database.model</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.List;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.StringTokenizer;
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  <strong>import</strong> org.apache.commons.lang.StringUtils;
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <em>/**<em>*</em></em>
<a name="28" href="#28">28</a>  <em> * A &lt;code>NameGenerator&lt;/code> implementation for Java-esque names.</em>
<a name="29" href="#29">29</a>  <em> *</em>
<a name="30" href="#30">30</a>  <em> * @author &lt;a href="<a href="mailto:dlr@finemaltcoding.com" target="alexandria_uri">mailto:dlr@finemaltcoding.com</a>>Daniel Rall&lt;/a></em>
<a name="31" href="#31">31</a>  <em> * @author &lt;a href="<a href="mailto:byron_foster@byron_foster@yahoo.com" target="alexandria_uri">mailto:byron_foster@byron_foster@yahoo.com</a>>Byron Foster&lt;/a></em>
<a name="32" href="#32">32</a>  <em> * @version $Id: JavaNameGenerator.java 473814 2006-11-11 22:30:30Z tv $</em>
<a name="33" href="#33">33</a>  <em> */</em>
<a name="34" href="#34">34</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../../org/apache/torque/engine/database/model/JavaNameGenerator.html">JavaNameGenerator</a> implements <a href="../../../../../../org/apache/torque/engine/database/model/NameGenerator.html">NameGenerator</a>
<a name="35" href="#35">35</a>  {
<a name="36" href="#36">36</a>      <em>/**<em>*</em></em>
<a name="37" href="#37">37</a>  <em>     * &lt;code>inputs&lt;/code> should consist of two elements, the</em>
<a name="38" href="#38">38</a>  <em>     * original name of the database element and the method for</em>
<a name="39" href="#39">39</a>  <em>     * generating the name.  There are currently three methods:</em>
<a name="40" href="#40">40</a>  <em>     * &lt;code>CONV_METHOD_NOCHANGE&lt;/code> - xml names are converted</em>
<a name="41" href="#41">41</a>  <em>     * directly to java names without modification.</em>
<a name="42" href="#42">42</a>  <em>     * &lt;code>CONV_METHOD_UNDERSCORE&lt;/code> will capitalize the first</em>
<a name="43" href="#43">43</a>  <em>     * letter, remove underscores, and capitalize each letter before</em>
<a name="44" href="#44">44</a>  <em>     * an underscore.  All other letters are lowercased. "javaname"</em>
<a name="45" href="#45">45</a>  <em>     * works the same as the &lt;code>CONV_METHOD_JAVANAME&lt;/code> method</em>
<a name="46" href="#46">46</a>  <em>     * but will not lowercase any characters.</em>
<a name="47" href="#47">47</a>  <em>     *</em>
<a name="48" href="#48">48</a>  <em>     * @param inputs list expected to contain two parameters, element</em>
<a name="49" href="#49">49</a>  <em>     * 0 contains name to convert, element 1 contains method for conversion.</em>
<a name="50" href="#50">50</a>  <em>     * @return The generated name.</em>
<a name="51" href="#51">51</a>  <em>     * @see org.apache.torque.engine.database.model.NameGenerator</em>
<a name="52" href="#52">52</a>  <em>     */</em>
<a name="53" href="#53">53</a>      <strong>public</strong> String generateName(List inputs)
<a name="54" href="#54">54</a>      {
<a name="55" href="#55">55</a>          String schemaName = (String) inputs.get(0);
<a name="56" href="#56">56</a>          String method = (String) inputs.get(1);
<a name="57" href="#57">57</a>          String javaName = <strong>null</strong>;
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>          <strong>if</strong> (CONV_METHOD_UNDERSCORE.equals(method))
<a name="60" href="#60">60</a>          {
<a name="61" href="#61">61</a>              javaName = underscoreMethod(schemaName);
<a name="62" href="#62">62</a>          }
<a name="63" href="#63">63</a>          <strong>else</strong> <strong>if</strong> (CONV_METHOD_UNDERSCORE_OMIT_SCHEMA.equals(method))
<a name="64" href="#64">64</a>          {
<a name="65" href="#65">65</a>              javaName = underscoreOmitSchemaMethod(schemaName);
<a name="66" href="#66">66</a>          }
<a name="67" href="#67">67</a>          <strong>else</strong> <strong>if</strong> (CONV_METHOD_JAVANAME.equals(method))
<a name="68" href="#68">68</a>          {
<a name="69" href="#69">69</a>              javaName = javanameMethod(schemaName);
<a name="70" href="#70">70</a>          }
<a name="71" href="#71">71</a>          <strong>else</strong> <strong>if</strong> (CONV_METHOD_NOCHANGE.equals(method))
<a name="72" href="#72">72</a>          {
<a name="73" href="#73">73</a>              javaName = nochangeMethod(schemaName);
<a name="74" href="#74">74</a>          }
<a name="75" href="#75">75</a>          <strong>else</strong>
<a name="76" href="#76">76</a>          {
<a name="77" href="#77">77</a>              <em class="comment">// if for some reason nothing is defined then we default</em>
<a name="78" href="#78">78</a>              <em class="comment">// to the traditional method.</em>
<a name="79" href="#79">79</a>              javaName = underscoreMethod(schemaName);
<a name="80" href="#80">80</a>          }
<a name="81" href="#81">81</a>  
<a name="82" href="#82">82</a>          <strong>return</strong> javaName;
<a name="83" href="#83">83</a>      }
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <em>/**<em>*</em></em>
<a name="86" href="#86">86</a>  <em>     * Converts a database schema name to java object name.  Removes</em>
<a name="87" href="#87">87</a>  <em>     * &lt;code>STD_SEPARATOR_CHAR&lt;/code> and &lt;code>SCHEMA_SEPARATOR_CHAR&lt;/code>,</em>
<a name="88" href="#88">88</a>  <em>     * capitilizes first letter of name and each letter after the</em>
<a name="89" href="#89">89</a>  <em>     * &lt;code>STD_SEPERATOR&lt;/code> and &lt;code>SCHEMA_SEPARATOR_CHAR&lt;/code>,</em>
<a name="90" href="#90">90</a>  <em>     * converts the rest of the letters to lowercase.</em>
<a name="91" href="#91">91</a>  <em>     *</em>
<a name="92" href="#92">92</a>  <em>     * @param schemaName name to be converted.</em>
<a name="93" href="#93">93</a>  <em>     * @return converted name.</em>
<a name="94" href="#94">94</a>  <em>     * @see org.apache.torque.engine.database.model.NameGenerator</em>
<a name="95" href="#95">95</a>  <em>     * @see #underscoreMethod(String)</em>
<a name="96" href="#96">96</a>  <em>     */</em>
<a name="97" href="#97">97</a>      <strong>protected</strong> String underscoreMethod(String schemaName)
<a name="98" href="#98">98</a>      {
<a name="99" href="#99">99</a>          StringBuffer name = <strong>new</strong> StringBuffer();
<a name="100" href="#100">100</a> 
<a name="101" href="#101">101</a>         <em class="comment">// remove the STD_SEPARATOR_CHARs and capitalize</em>
<a name="102" href="#102">102</a>         <em class="comment">// the tokens</em>
<a name="103" href="#103">103</a>         StringTokenizer tok = <strong>new</strong> StringTokenizer
<a name="104" href="#104">104</a>             (schemaName, String.valueOf(STD_SEPARATOR_CHAR));
<a name="105" href="#105">105</a>         <strong>while</strong> (tok.hasMoreTokens())
<a name="106" href="#106">106</a>         {
<a name="107" href="#107">107</a>             String namePart = ((String) tok.nextElement()).toLowerCase();
<a name="108" href="#108">108</a>             name.append(StringUtils.capitalize(namePart));
<a name="109" href="#109">109</a>         }
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>         <em class="comment">// remove the SCHEMA_SEPARATOR_CHARs and capitalize</em>
<a name="112" href="#112">112</a>         <em class="comment">// the tokens</em>
<a name="113" href="#113">113</a>         schemaName = name.toString();
<a name="114" href="#114">114</a>         name = <strong>new</strong> StringBuffer();
<a name="115" href="#115">115</a>         tok = <strong>new</strong> StringTokenizer
<a name="116" href="#116">116</a>             (schemaName, String.valueOf(SCHEMA_SEPARATOR_CHAR));
<a name="117" href="#117">117</a>         <strong>while</strong> (tok.hasMoreTokens())
<a name="118" href="#118">118</a>         {
<a name="119" href="#119">119</a>             String namePart = (String) tok.nextElement();
<a name="120" href="#120">120</a>             name.append(StringUtils.capitalize(namePart));
<a name="121" href="#121">121</a>         }
<a name="122" href="#122">122</a>         <strong>return</strong> name.toString();
<a name="123" href="#123">123</a>     }
<a name="124" href="#124">124</a> 
<a name="125" href="#125">125</a>     <em>/**<em>*</em></em>
<a name="126" href="#126">126</a> <em>     * Converts a database schema name to java object name.</em>
<a name="127" href="#127">127</a> <em>     * First, it removes all characters before the last occurence of</em>
<a name="128" href="#128">128</a> <em>     * .&lt;code>SCHEMA_SEPARATOR_CHAR&lt;/code>. Then, in a second step, removes</em>
<a name="129" href="#129">129</a> <em>     * &lt;code>STD_SEPARATOR_CHAR&lt;/code>, capitilizes first letter of</em>
<a name="130" href="#130">130</a> <em>     * name and each letter after the &lt;code>STD_SEPERATOR&lt;/code>,</em>
<a name="131" href="#131">131</a> <em>     * and converts the rest of the letters to lowercase.</em>
<a name="132" href="#132">132</a> <em>     *</em>
<a name="133" href="#133">133</a> <em>     * @param schemaName name to be converted.</em>
<a name="134" href="#134">134</a> <em>     * @return converted name.</em>
<a name="135" href="#135">135</a> <em>     * @see org.apache.torque.engine.database.model.NameGenerator</em>
<a name="136" href="#136">136</a> <em>     * @see #underscoreOmitSchemaMethod(String)</em>
<a name="137" href="#137">137</a> <em>     */</em>
<a name="138" href="#138">138</a>     <strong>protected</strong> String underscoreOmitSchemaMethod(String schemaName)
<a name="139" href="#139">139</a>     {
<a name="140" href="#140">140</a>         <em class="comment">// take only part after last dot</em>
<a name="141" href="#141">141</a>         <strong>int</strong> lastDotPos = schemaName.lastIndexOf(SCHEMA_SEPARATOR_CHAR);
<a name="142" href="#142">142</a>         <strong>if</strong> (lastDotPos != -1)
<a name="143" href="#143">143</a>         {
<a name="144" href="#144">144</a>             schemaName = schemaName.substring(lastDotPos + 1);
<a name="145" href="#145">145</a>         }
<a name="146" href="#146">146</a>         StringBuffer name = <strong>new</strong> StringBuffer();
<a name="147" href="#147">147</a>         StringTokenizer tok = <strong>new</strong> StringTokenizer
<a name="148" href="#148">148</a>             (schemaName, String.valueOf(STD_SEPARATOR_CHAR));
<a name="149" href="#149">149</a>         <strong>while</strong> (tok.hasMoreTokens())
<a name="150" href="#150">150</a>         {
<a name="151" href="#151">151</a>             String namePart = ((String) tok.nextElement()).toLowerCase();
<a name="152" href="#152">152</a>             name.append(StringUtils.capitalize(namePart));
<a name="153" href="#153">153</a>         }
<a name="154" href="#154">154</a>         <strong>return</strong> name.toString();
<a name="155" href="#155">155</a>     }
<a name="156" href="#156">156</a> 
<a name="157" href="#157">157</a>     <em>/**<em>*</em></em>
<a name="158" href="#158">158</a> <em>     * Converts a database schema name to java object name.  Operates</em>
<a name="159" href="#159">159</a> <em>     * same as underscoreMethod but does not convert anything to</em>
<a name="160" href="#160">160</a> <em>     * lowercase.</em>
<a name="161" href="#161">161</a> <em>     *</em>
<a name="162" href="#162">162</a> <em>     * @param schemaName name to be converted.</em>
<a name="163" href="#163">163</a> <em>     * @return converted name.</em>
<a name="164" href="#164">164</a> <em>     * @see org.apache.torque.engine.database.model.NameGenerator</em>
<a name="165" href="#165">165</a> <em>     * @see #underscoreMethod(String)</em>
<a name="166" href="#166">166</a> <em>     */</em>
<a name="167" href="#167">167</a>     <strong>protected</strong> String javanameMethod(String schemaName)
<a name="168" href="#168">168</a>     {
<a name="169" href="#169">169</a>         StringBuffer name = <strong>new</strong> StringBuffer();
<a name="170" href="#170">170</a>         StringTokenizer tok = <strong>new</strong> StringTokenizer
<a name="171" href="#171">171</a>             (schemaName, String.valueOf(STD_SEPARATOR_CHAR));
<a name="172" href="#172">172</a>         <strong>while</strong> (tok.hasMoreTokens())
<a name="173" href="#173">173</a>         {
<a name="174" href="#174">174</a>             String namePart = (String) tok.nextElement();
<a name="175" href="#175">175</a>             name.append(StringUtils.capitalize(namePart));
<a name="176" href="#176">176</a>         }
<a name="177" href="#177">177</a> 
<a name="178" href="#178">178</a>         <em class="comment">// remove the SCHEMA_SEPARATOR_CHARs and capitalize</em>
<a name="179" href="#179">179</a>         <em class="comment">// the tokens</em>
<a name="180" href="#180">180</a>         schemaName = name.toString();
<a name="181" href="#181">181</a>         name = <strong>new</strong> StringBuffer();
<a name="182" href="#182">182</a> 
<a name="183" href="#183">183</a>         tok = <strong>new</strong> StringTokenizer
<a name="184" href="#184">184</a>             (schemaName, String.valueOf(SCHEMA_SEPARATOR_CHAR));
<a name="185" href="#185">185</a>         <strong>while</strong> (tok.hasMoreTokens())
<a name="186" href="#186">186</a>         {
<a name="187" href="#187">187</a>             String namePart = (String) tok.nextElement();
<a name="188" href="#188">188</a>             name.append(StringUtils.capitalize(namePart));
<a name="189" href="#189">189</a>         }
<a name="190" href="#190">190</a>         <strong>return</strong> name.toString();
<a name="191" href="#191">191</a>     }
<a name="192" href="#192">192</a> 
<a name="193" href="#193">193</a>     <em>/**<em>*</em></em>
<a name="194" href="#194">194</a> <em>     * Converts a database schema name to java object name.  In this</em>
<a name="195" href="#195">195</a> <em>     * case no conversion is made.</em>
<a name="196" href="#196">196</a> <em>     *</em>
<a name="197" href="#197">197</a> <em>     * @param name name to be converted.</em>
<a name="198" href="#198">198</a> <em>     * @return The &lt;code>name&lt;/code> parameter, unchanged.</em>
<a name="199" href="#199">199</a> <em>     */</em>
<a name="200" href="#200">200</a>     <strong>protected</strong> <strong>final</strong> String nochangeMethod(String name)
<a name="201" href="#201">201</a>     {
<a name="202" href="#202">202</a>         <strong>return</strong> name;
<a name="203" href="#203">203</a>     }
<a name="204" href="#204">204</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

